<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>cr-enc-handler: Libcroco Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Libcroco Reference Manual">
<link rel="up" href="ch01.html" title="Extensive APIs description">
<link rel="prev" href="libcroco-cr-doc-handler.html" title="cr-doc-handler">
<link rel="next" href="libcroco-cr-fonts.html" title="cr-fonts">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libcroco-cr-enc-handler.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libcroco-cr-doc-handler.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libcroco-cr-fonts.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libcroco-cr-enc-handler"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libcroco-cr-enc-handler.top_of_page"></a>cr-enc-handler</span></h2>
<p>cr-enc-handler</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libcroco-cr-enc-handler.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="libcroco-cr-enc-handler.html#CREncHandler" title="CREncHandler"><span class="returnvalue">CREncHandler</span></a> *
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-enc-handler.html#cr-enc-handler-get-instance" title="cr_enc_handler_get_instance ()">cr_enc_handler_get_instance</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-enc-handler.html#cr-enc-handler-resolve-enc-alias" title="cr_enc_handler_resolve_enc_alias ()">cr_enc_handler_resolve_enc_alias</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-enc-handler.html#cr-enc-handler-convert-input" title="cr_enc_handler_convert_input ()">cr_enc_handler_convert_input</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libcroco-cr-enc-handler.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libcroco-cr-enc-handler.html#CREncHandler" title="CREncHandler">CREncHandler</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libcroco-cr-enc-handler.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libcroco-cr-enc-handler.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="cr-enc-handler-get-instance"></a><h3>cr_enc_handler_get_instance ()</h3>
<pre class="programlisting"><a class="link" href="libcroco-cr-enc-handler.html#CREncHandler" title="CREncHandler"><span class="returnvalue">CREncHandler</span></a> *
cr_enc_handler_get_instance (<em class="parameter"><code><span class="type">enum CREncoding</span> a_enc</code></em>);</pre>
<p>Gets the instance of encoding handler.
This function implements a singleton pattern.</p>
<p>Returns the instance of <a class="link" href="libcroco-cr-enc-handler.html#CREncHandler" title="CREncHandler"><span class="type">CREncHandler</span></a>.</p>
<div class="refsect3">
<a name="id-1.2.7.6.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>a_enc</p></td>
<td class="parameter_description"><p>the encoding of the Handler.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-enc-handler-resolve-enc-alias"></a><h3>cr_enc_handler_resolve_enc_alias ()</h3>
<pre class="programlisting">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
cr_enc_handler_resolve_enc_alias (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *a_alias_name</code></em>,
                                  <em class="parameter"><code><span class="type">enum CREncoding</span> *a_enc</code></em>);</pre>
<p>Given an encoding name (called an alias name)
the function returns the matching encoding type.</p>
<p>Returns CR_OK upon successfull completion, an error code otherwise.</p>
<div class="refsect3">
<a name="id-1.2.7.6.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>a_alias_name</p></td>
<td class="parameter_description"><p>the encoding name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_enc</p></td>
<td class="parameter_description"><p>output param. The returned encoding type
or 0 if the alias is not supported.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-enc-handler-convert-input"></a><h3>cr_enc_handler_convert_input ()</h3>
<pre class="programlisting">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
cr_enc_handler_convert_input (<em class="parameter"><code><a class="link" href="libcroco-cr-enc-handler.html#CREncHandler" title="CREncHandler"><span class="type">CREncHandler</span></a> *a_this</code></em>,
                              <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *a_in</code></em>,
                              <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> *a_in_len</code></em>,
                              <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **a_out</code></em>,
                              <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> *a_out_len</code></em>);</pre>
<p>Converts a raw input buffer into an utf8 buffer.</p>
<p>Returns CR_OK upon successfull completion, an error code otherwise.</p>
<div class="refsect3">
<a name="id-1.2.7.6.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the current instance of <a class="link" href="libcroco-cr-enc-handler.html#CREncHandler" title="CREncHandler"><span class="type">CREncHandler</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_in</p></td>
<td class="parameter_description"><p>the input buffer to convert.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_in_len</p></td>
<td class="parameter_description"><p>in/out parameter. The len of the input
buffer to convert. After return, contains the number of
bytes actually consumed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_out</p></td>
<td class="parameter_description"><p>output parameter. The converted output buffer.
Must be freed by the buffer.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_out_len</p></td>
<td class="parameter_description"><p>output parameter. The length of the output buffer.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libcroco-cr-enc-handler.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CREncHandler"></a><h3>CREncHandler</h3>
<pre class="programlisting">typedef struct _CREncHandler CREncHandler;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>